<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta name="Content-Type" content="text/html; charset=UTF-8" />
<title>Module: Sass</title>
<link rel="stylesheet" href="style.css" tppabs="http://sass-lang.com/docs/yardoc/css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="common.css" tppabs="http://sass-lang.com/docs/yardoc/css/common.css" type="text/css" media="screen" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  relpath = '';
  if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="jquery.js" tppabs="http://sass-lang.com/docs/yardoc/js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="app.js" tppabs="http://sass-lang.com/docs/yardoc/js/app.js"></script>

  </head>
  <body>
    <script type="text/javascript" charset="utf-8">
      if (window.top.frames.main) document.body.className = 'frames';
    </script>
    
    <div id="header">
      <div id="menu">
  
    <a href="_index.html" tppabs="http://sass-lang.com/docs/yardoc/_index.html">Index (S)</a> &raquo; 
    
    
    <span class="title">Sass</span>
  
  
  <div class="noframes"><span class="title">(</span><a href="..htm" tppabs="http://sass-lang.com/docs/yardoc/." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  <a id="class_list_link" href="#">Class List</a>
  <a id="method_list_link" href="#">Method List</a>
  <a id ="file_list_link" href="#">File List</a>
</div>

      <div class="clear"></div>
    </div>
    
    <iframe id="search_frame"></iframe>
    
    <div id="content"><h1>Module: Sass 
  
  
</h1>

<dl class="box">
  
  
    
      <dt class="r1">Extends:</dt>
      <dd class="r1"><a href="Version.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Version.html" title="Sass::Version (module)">Sass::Version</a></dd>
      
    
  
    
  
  
    <dt class="r2 last">Defined in:</dt>
    <dd class="r2 last">/var/www/sass-pages/.sass/lib/sass.rb<span class="defines">,<br />
  /var/www/sass-pages/.sass/lib/sass/css.rb,<br /> /var/www/sass-pages/.sass/lib/sass/repl.rb,<br /> /var/www/sass-pages/.sass/lib/sass/util.rb,<br /> /var/www/sass-pages/.sass/lib/sass/root.rb,<br /> /var/www/sass-pages/.sass/lib/sass/scss.rb,<br /> /var/www/sass-pages/.sass/lib/sass/exec.rb,<br /> /var/www/sass-pages/.sass/lib/sass/error.rb,<br /> /var/www/sass-pages/.sass/lib/sass/engine.rb,<br /> /var/www/sass-pages/.sass/lib/sass/plugin.rb,<br /> /var/www/sass-pages/.sass/lib/sass/logger.rb,<br /> /var/www/sass-pages/.sass/lib/sass/shared.rb,<br /> /var/www/sass-pages/.sass/lib/sass/script.rb,<br /> /var/www/sass-pages/.sass/lib/sass/version.rb,<br /> /var/www/sass-pages/.sass/lib/sass/scss/rx.rb,<br /> /var/www/sass-pages/.sass/lib/sass/selector.rb,<br /> /var/www/sass-pages/.sass/lib/sass/tree/node.rb,<br /> /var/www/sass-pages/.sass/lib/sass/importers.rb,<br /> /var/www/sass-pages/.sass/lib/sass/callbacks.rb,<br /> /var/www/sass-pages/.sass/lib/sass/plugin/rack.rb,<br /> /var/www/sass-pages/.sass/lib/sass/scss/parser.rb,<br /> /var/www/sass-pages/.sass/lib/sass/environment.rb,<br /> /var/www/sass-pages/.sass/lib/sass/script/lexer.rb,<br /> /var/www/sass-pages/.sass/lib/sass/cache_stores.rb,<br /> /var/www/sass-pages/.sass/lib/sass/script/parser.rb,<br /> /var/www/sass-pages/.sass/lib/sass/script/funcall.rb,<br /> /var/www/sass-pages/.sass/lib/sass/importers/base.rb,<br /> /var/www/sass-pages/.sass/lib/sass/tree/root_node.rb,<br /> /var/www/sass-pages/.sass/lib/sass/tree/warn_node.rb,<br /> /var/www/sass-pages/.sass/lib/sass/selector/simple.rb,<br /> /var/www/sass-pages/.sass/lib/sass/scss/css_parser.rb,<br /> /var/www/sass-pages/.sass/lib/sass/script/variable.rb,<br /> /var/www/sass-pages/.sass/lib/sass/util/subset_map.rb,<br /> /var/www/sass-pages/.sass/lib/sass/tree/debug_node.rb,<br /> /var/www/sass-pages/.sass/lib/sass/tree/return_node.rb,<br /> /var/www/sass-pages/.sass/lib/sass/tree/import_node.rb,<br /> /var/www/sass-pages/.sass/lib/sass/logger/log_level.rb,<br /> /var/www/sass-pages/.sass/lib/sass/script/css_lexer.rb,<br /> /var/www/sass-pages/.sass/lib/sass/cache_stores/base.rb,<br /> /var/www/sass-pages/.sass/lib/sass/script/css_parser.rb,<br /> /var/www/sass-pages/.sass/lib/sass/scss/script_lexer.rb,<br /> /var/www/sass-pages/.sass/lib/sass/tree/content_node.rb,<br /> /var/www/sass-pages/.sass/lib/sass/cache_stores/null.rb,<br /> /var/www/sass-pages/.sass/lib/sass/selector/sequence.rb,<br /> /var/www/sass-pages/.sass/lib/sass/scss/script_parser.rb,<br /> /var/www/sass-pages/.sass/lib/sass/tree/function_node.rb,<br /> /var/www/sass-pages/.sass/lib/sass/cache_stores/chain.rb,<br /> /var/www/sass-pages/.sass/lib/sass/tree/variable_node.rb,<br /> /var/www/sass-pages/.sass/lib/sass/scss/static_parser.rb,<br /> /var/www/sass-pages/.sass/lib/sass/cache_stores/memory.rb,<br /> /var/www/sass-pages/.sass/lib/sass/tree/mixin_def_node.rb,<br /> /var/www/sass-pages/.sass/lib/sass/plugin/configuration.rb,<br /> /var/www/sass-pages/.sass/lib/sass/importers/filesystem.rb,<br /> /var/www/sass-pages/.sass/lib/sass/selector/comma_sequence.rb,<br /> /var/www/sass-pages/.sass/lib/sass/cache_stores/filesystem.rb,<br /> /var/www/sass-pages/.sass/lib/sass/selector/simple_sequence.rb,<br /> /var/www/sass-pages/.sass/lib/sass/plugin/staleness_checker.rb,<br /> /var/www/sass-pages/.sass/lib/sass/selector/abstract_sequence.rb</span>
</dd>
  
</dl>
<div class="clear"></div>

<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    <p>We keep configuration in its own self-contained file so that we can load it independently in Rails 3, where the full plugin stuff is lazy-loaded.</p>

  </div>
</div>
<div class="tags">
  
</div><h2>Defined Under Namespace</h2>
<p class="children">
   
    
      <strong class="modules">Modules:</strong> <a href="CacheStores.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/CacheStores.html" title="Sass::CacheStores (module)">CacheStores</a>, <a href="Callbacks.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Callbacks.html" title="Sass::Callbacks (module)">Callbacks</a>, <a href="Exec.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Exec.html" title="Sass::Exec (module)">Exec</a>, <a href="Importers.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Importers.html" title="Sass::Importers (module)">Importers</a>, <a href="Logger.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Logger.html" title="Sass::Logger (module)">Logger</a>, <a href="Media.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Media.html" title="Sass::Media (module)">Media</a>, <a href="Plugin.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Plugin.html" title="Sass::Plugin (module)">Plugin</a>, <a href="SCSS.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/SCSS.html" title="Sass::SCSS (module)">SCSS</a>, <a href="Script.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Script.html" title="Sass::Script (module)">Script</a>, <a href="Selector.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Selector.html" title="Sass::Selector (module)">Selector</a>, <a href="Shared.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Shared.html" title="Sass::Shared (module)">Shared</a>, <a href="Supports.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Supports.html" title="Sass::Supports (module)">Supports</a>, <a href="Tree.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Tree.html" title="Sass::Tree (module)">Tree</a>, <a href="Util.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Util.html" title="Sass::Util (module)">Util</a>, <a href="Version.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Version.html" title="Sass::Version (module)">Version</a>
    
   
    
      <strong class="classes">Classes:</strong> <a href="CSS.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/CSS.html" title="Sass::CSS (class)">CSS</a>, <a href="Callable.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Callable.html" title="Sass::Callable (class)">Callable</a>, <a href="Engine.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Engine.html" title="Sass::Engine (class)">Engine</a>, <a href="Environment.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Environment.html" title="Sass::Environment (class)">Environment</a>, <a href="Repl.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Repl.html" title="Sass::Repl (class)">Repl</a>, <a href="SyntaxError.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/SyntaxError.html" title="Sass::SyntaxError (class)">SyntaxError</a>, <a href="UnitConversionError.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/UnitConversionError.html" title="Sass::UnitConversionError (class)">UnitConversionError</a>
    
  
</p>

  <h2>Constant Summary</h2>
  
    <dl class="constants">
      
        <dt id="ROOT_DIR-constant" class="">ROOT_DIR =
            <span class="summary_desc">The root directory of the Sass source tree.</span>
        </dt>
        <dd><pre class="code">File.expand_path(File.join(__FILE__, "../../.."))</pre></dd>
      
        <dt id="VERSION-constant" class="">VERSION =
            <span class="summary_desc">A string representing the version of Sass.</span>
        </dt>
        <dd><pre class="code">version[:string] unless defined?(Sass::VERSION)</pre></dd>
      
    </dl>
  


  <h2>Class Attribute Summary</h2>
  <ul class="summary">
    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#logger-class_method" title="logger (class method)">+ <strong>logger</strong> </a>
    

    
  </span>
  
  
    
    
  
  
  
  

  
    <span class="summary_desc">Returns the value of attribute logger.</span>
  
</li>

    
  </ul>


  <h2>Class Method Summary</h2>

  <ul class="summary">
    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#compile-class_method" title="compile (class method)">+ <strong>compile</strong>(contents, options = {}) </a>
    

    
  </span>
  
  
  
  
  

  
    <span class="summary_desc">Compile a Sass or SCSS string to CSS.</span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#compile_file-class_method" title="compile_file (class method)">+ <strong>compile_file</strong>(filename, *args) </a>
    

    
  </span>
  
  
  
  
  

  
    <span class="summary_desc">Compile a file on disk to CSS.</span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#load_paths-class_method" title="load_paths (class method)">+ (Array&lt;String, Pathname, Sass::Importers::Base&gt;) <strong>load_paths</strong> </a>
    

    
  </span>
  
  
  
  
  

  
    <span class="summary_desc">The global load paths for Sass files.</span>
  
</li>

    
  </ul>

  <div id="class_attr_details" class="attr_details">
    <h2>Class Attribute Details</h2>
    
      
      <span id="logger=-class_method"></span>
      <span id="logger-class_method"></span>
      <div class="method_details first">
  <p class="signature first" id="logger-class_method">
  
    + <strong>logger</strong> 
  

  
</p><div class="docstring">
  <div class="discussion">
    <p>Returns the value of attribute logger</p>

  </div>
</div>
<div class="tags">
  
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


11
12
13</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File '/var/www/sass-pages/.sass/lib/sass/logger.rb', line 11</span>

def logger
  @logger
end</pre>
    </td>
  </tr>
</table>
</div>
    
  </div>


  <div id="class_method_details" class="method_details_list">
    <h2>Class Method Details</h2>
    
    
      <div class="method_details first">
  <p class="signature first" id="compile-class_method">
  
    + <strong>compile</strong>(contents, options = {}) 
  

  
</p><div class="docstring">
  <div class="discussion">
    <p>Compile a Sass or SCSS string to CSS. Defaults to SCSS.</p>

  </div>
</div>
<div class="tags">
  <h3>Parameters:</h3>
<ul class="param">
  
    <li>
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <span class='name'>contents</span>
      
      
      
        &mdash;
        The contents of the Sass file.
      
    </li>
  
    <li>
      
        <span class='type'>(<tt>{Symbol =&gt; Object}</tt>)</span>
      
      
        <span class='name'>options</span>
      
      
        <em class="default">(defaults to: <tt>{}</tt>)</em>
      
      
        &mdash;
        An options hash; see <a href="file.SASS_REFERENCE.html#sass_options" tppabs="http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#sass_options" title="the Sass options documentation">the Sass options documentation</a>
      
    </li>
  
</ul>
<h3>Raises:</h3>
<ul class="raise">
  
    <li>
      
        <span class='type'>(<tt><a href="SyntaxError.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/SyntaxError.html" title="Sass::SyntaxError (class)">Sass::SyntaxError</a></tt>)</span>
      
      
      
      
        &mdash;
        if there&#8217;s an error in the document
      
    </li>
  
    <li>
      
        <span class='type'>(<tt>Encoding::UndefinedConversionError</tt>)</span>
      
      
      
      
        &mdash;
        if the source encoding cannot be converted to UTF-8
      
    </li>
  
    <li>
      
        <span class='type'>(<tt>ArgumentError</tt>)</span>
      
      
      
      
        &mdash;
        if the document uses an unknown encoding with <code>@charset</code>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


52
53
54
55</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File '/var/www/sass-pages/.sass/lib/sass.rb', line 52</span>

def self.compile(contents, options = {})
  options[:syntax] ||= :scss
  Engine.new(contents, options).to_css
end</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="compile_file-class_method">
  
    
      <span class="overload">+ (<tt>String</tt>) <strong>compile_file</strong>(filename, options = {}) </span>
    
      <span class="overload">+ <strong>compile_file</strong>(filename, css_filename, options = {}) </span>
    
  

  
</p><div class="docstring">
  <div class="discussion">
    <p>Compile a file on disk to CSS.</p>

  </div>
</div>
<div class="tags">
  
  <h3>Overloads:</h3>
  <ul class="overload">
    
      
      <li class="overload_item">
        <span class="signature">+ (<tt>String</tt>) <strong>compile_file</strong>(filename, options = {}) </span>
        <div class="docstring">
  <div class="discussion">
    <p>Return the compiled CSS rather than writing it to a file.</p>

  </div>
</div>
<div class="tags">
  <h3>Returns:</h3>
<ul class="return">
  
    <li>
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
      
        &mdash;
        The compiled CSS.
      
    </li>
  
</ul>

</div>
      </li>
    
      
      <li class="overload_item">
        <span class="signature">+ <strong>compile_file</strong>(filename, css_filename, options = {}) </span>
        <div class="docstring">
  <div class="discussion">
    <p>Write the compiled CSS to a file.</p>

  </div>
</div>
<div class="tags">
  <h3>Parameters:</h3>
<ul class="param">
  
    <li>
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <span class='name'>css_filename</span>
      
      
      
        &mdash;
        The location to which to write the compiled CSS.
      
    </li>
  
</ul>

</div>
      </li>
    
  </ul>
<h3>Parameters:</h3>
<ul class="param">
  
    <li>
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <span class='name'>filename</span>
      
      
      
        &mdash;
        The path to the Sass, SCSS, or CSS file on disk.
      
    </li>
  
    <li>
      
        <span class='type'>(<tt>{Symbol =&gt; Object}</tt>)</span>
      
      
        <span class='name'>options</span>
      
      
      
        &mdash;
        An options hash; see <a href="file.SASS_REFERENCE.html#sass_options" tppabs="http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#sass_options" title="the Sass options documentation">the Sass options documentation</a>
      
    </li>
  
</ul>
<h3>Raises:</h3>
<ul class="raise">
  
    <li>
      
        <span class='type'>(<tt><a href="SyntaxError.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/SyntaxError.html" title="Sass::SyntaxError (class)">Sass::SyntaxError</a></tt>)</span>
      
      
      
      
        &mdash;
        if there&#8217;s an error in the document
      
    </li>
  
    <li>
      
        <span class='type'>(<tt>Encoding::UndefinedConversionError</tt>)</span>
      
      
      
      
        &mdash;
        if the source encoding cannot be converted to UTF-8
      
    </li>
  
    <li>
      
        <span class='type'>(<tt>ArgumentError</tt>)</span>
      
      
      
      
        &mdash;
        if the document uses an unknown encoding with <code>@charset</code>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


76
77
78
79
80
81
82
83
84
85
86
87</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File '/var/www/sass-pages/.sass/lib/sass.rb', line 76</span>

def self.compile_file(filename, *args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  css_filename = args.shift
  result = Sass::Engine.for_file(filename, options).render
  if css_filename
    options[:css_filename] ||= css_filename
    open(css_filename,"w") {|css_file| css_file.write(result)}
    nil
  else
    result
  end
end</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="load_paths-class_method">
  
    + (<tt>Array&lt;String, Pathname, <a href="Base-3.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Importers/Base.html" title="Sass::Importers::Base (class)">Sass::Importers::Base</a>&gt;</tt>) <strong>load_paths</strong> 
  

  
</p><div class="docstring">
  <div class="discussion">
    <p>The global load paths for Sass files. This is meant for plugins and libraries to register the paths to their Sass stylesheets to that they may be <code>@imported</code>. This load path is used by every instance of <span>Sass::Engine</span>. They are lower-precedence than any load paths passed in via the <a href="file.SASS_REFERENCE.html#load_paths-option" tppabs="http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#load_paths-option" title="&lt;code&gt;:load_paths&lt;/code&gt; option"><code>:load_paths</code> option</a>.</p>

<p>If the <code>SASS_PATH</code> environment variable is set, the initial value of <code>load_paths</code> will be initialized based on that. The variable should be a colon-separated list of path names (semicolon-separated on Windows).</p>

<p>Note that files on the global load path are never compiled to CSS themselves, even if they aren&#8217;t partials. They exist only to be imported.</p>

  </div>
</div>
<div class="tags">
  
  <div class="examples">
    <h3>Examples:</h3>
    
      <h4></h4>
      <pre class="example code">  Sass.load_paths << File.dirname(__FILE__ + '/sass')</pre>
    
  </div>
<h3>Returns:</h3>
<ul class="return">
  
    <li>
      
        <span class='type'>(<tt>Array&lt;String, Pathname, <a href="Base-3.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Importers/Base.html" title="Sass::Importers::Base (class)">Sass::Importers::Base</a>&gt;</tt>)</span>
      
      
      
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


37
38
39
40</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File '/var/www/sass-pages/.sass/lib/sass.rb', line 37</span>

def self.load_paths
  @load_paths ||= ENV['SASS_PATH'] ?
    ENV['SASS_PATH'].split(Sass::Util.windows? ? ';' : ':') : []
end</pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>
    
    <div id="footer">
  Generated on Fri Mar  8 20:33:30 2013 by 
  <a href="javascript:if(confirm(%27http://yardoc.org/  \n\nThis file was not retrieved by Teleport Pro, because it is addressed on a domain or path outside the boundaries set for its Starting Address.  \n\nDo you want to open it from the server?%27))window.location=%27http://yardoc.org/%27" tppabs="http://yardoc.org/" title="Yay! A Ruby Documentation Tool">yard</a>
  0.5.3 (ruby-1.8.7).
</div>


  <script type="text/javascript">
  var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
  document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
  </script>
  <script type="text/javascript">
  try {
  var pageTracker = _gat._getTracker("UA-535380-8");
  pageTracker._trackPageview();
  } catch(err) {}</script>


  </body>
</html>